<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: async/timed_concurrent_task_loop.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ddc98e6e1a9e0f6adcacab8ac7c1f855.html">async</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">timed_concurrent_task_loop.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="timed__concurrent__task__loop_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="timed__concurrent__task__loop_8hpp.html">flow/async/timed_concurrent_task_loop.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1async.html">flow::async</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>{</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Timed__concurrent__task__loop.html#a38f7effbd882c15178dc821306e8a0bc">   27</a></span><a class="code hl_function" href="classflow_1_1async_1_1Timed__concurrent__task__loop.html#a38f7effbd882c15178dc821306e8a0bc">Timed_concurrent_task_loop::Timed_concurrent_task_loop</a>(<a class="code hl_class" href="classflow_1_1async_1_1Concurrent__task__loop.html">Concurrent_task_loop</a>* loop, <a class="code hl_enumeration" href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">perf::Clock_type</a> clock_type) :</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>  <a class="code hl_class" href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html">Impl</a>(loop, clock_type,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>       <span class="comment">// Thread-safe.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>       [](<a class="code hl_typedef" href="classflow_1_1async_1_1Timed__concurrent__task__loop.html#a979755c94c0f080fb40d23a61c1a0049">Time_accumulator</a>* time_acc) -&gt; perf::<a class="code hl_typedef" href="namespaceflow_1_1perf.html#a75b06c669e720c60621f3c68c3d34408">duration_rep_t</a> { return time_acc-&gt;exchange(0); })</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  <span class="comment">// That&#39;s it.  The above is why we exist as a subclass and not just an alias.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>}</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>} <span class="comment">// namespace flow::async</span></div>
<div class="ttc" id="aclassflow_1_1async_1_1Concurrent__task__loop_html"><div class="ttname"><a href="classflow_1_1async_1_1Concurrent__task__loop.html">flow::async::Concurrent_task_loop</a></div><div class="ttdoc">The core flow::async interface, providing an optionally multi-threaded thread pool onto which runnabl...</div><div class="ttdef"><b>Definition:</b> <a href="concurrent__task__loop_8hpp_source.html#l00322">concurrent_task_loop.hpp:324</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__concurrent__task__loop__impl_html"><div class="ttname"><a href="classflow_1_1async_1_1Timed__concurrent__task__loop__impl.html">flow::async::Timed_concurrent_task_loop_impl</a></div><div class="ttdoc">Decorator of a Concurrent_task_loop with same or greater lifetime that accumulates time elapsed in an...</div><div class="ttdef"><b>Definition:</b> <a href="timed__concurrent__task__loop_8hpp_source.html#l00051">timed_concurrent_task_loop.hpp:52</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__concurrent__task__loop_html_a38f7effbd882c15178dc821306e8a0bc"><div class="ttname"><a href="classflow_1_1async_1_1Timed__concurrent__task__loop.html#a38f7effbd882c15178dc821306e8a0bc">flow::async::Timed_concurrent_task_loop::Timed_concurrent_task_loop</a></div><div class="ttdeci">Timed_concurrent_task_loop(Concurrent_task_loop *loop, perf::Clock_type clock_type=perf::Clock_type::S_CPU_THREAD_TOTAL_HI_RES)</div><div class="ttdoc">Constructs a time-accumulating version of existing loop *loop.</div><div class="ttdef"><b>Definition:</b> <a href="timed__concurrent__task__loop_8cpp_source.html#l00027">timed_concurrent_task_loop.cpp:27</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Timed__concurrent__task__loop_html_a979755c94c0f080fb40d23a61c1a0049"><div class="ttname"><a href="classflow_1_1async_1_1Timed__concurrent__task__loop.html#a979755c94c0f080fb40d23a61c1a0049">flow::async::Timed_concurrent_task_loop::Time_accumulator</a></div><div class="ttdeci">std::atomic&lt; perf::duration_rep_t &gt; Time_accumulator</div><div class="ttdoc">Convenience alias to our thread-safe tick accumulator type.</div><div class="ttdef"><b>Definition:</b> <a href="timed__concurrent__task__loop_8hpp_source.html#l00281">timed_concurrent_task_loop.hpp:281</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html"><div class="ttname"><a href="namespaceflow_1_1async.html">flow::async</a></div><div class="ttdoc">Flow module containing tools enabling multi-threaded event loops operating under the asynchronous-tas...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00074">async_fwd.hpp:75</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_a75b06c669e720c60621f3c68c3d34408"><div class="ttname"><a href="namespaceflow_1_1perf.html#a75b06c669e720c60621f3c68c3d34408">flow::perf::duration_rep_t</a></div><div class="ttdeci">Duration::rep duration_rep_t</div><div class="ttdoc">The raw type used in Duration to store its clock ticks.</div><div class="ttdef"><b>Definition:</b> <a href="clock__type__fwd_8hpp_source.html#l00050">clock_type_fwd.hpp:50</a></div></div>
<div class="ttc" id="anamespaceflow_1_1perf_html_ad61fb186191e4bb824d14601d11a2eb0"><div class="ttname"><a href="namespaceflow_1_1perf.html#ad61fb186191e4bb824d14601d11a2eb0">flow::perf::Clock_type</a></div><div class="ttdeci">Clock_type</div><div class="ttdoc">Clock types supported by flow::perf module facilities, perf::Checkpointing_timer in particular.</div><div class="ttdef"><b>Definition:</b> <a href="clock__type__fwd_8hpp_source.html#l00066">clock_type_fwd.hpp:67</a></div></div>
<div class="ttc" id="atimed__concurrent__task__loop_8hpp_html"><div class="ttname"><a href="timed__concurrent__task__loop_8hpp.html">timed_concurrent_task_loop.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
